untun

🚇 untun

Tunnel your local HTTP(s) server to the world!

Powered by 🔥 Cloudflare Quick Tunnels and used by 👂 unjs/listhen.

Usage (CLI)

Globally run tunnel with npx:

npx untun@latest tunnel http://localhost:3000

◐ Starting cloudflared tunnel to http://localhost:3000
ℹ Waiting for tunnel URL...
✔ Tunnel ready at https://unjs-is-awesome.trycloudflare.com

Use npx untun tunnel --help for more usage info.

Usage (API)

Install package:

# npm
npm install untun

# yarn
yarn add untun

# pnpm
pnpm install untun

Import:

// ESM
import { startTunnel } from "untun";

// CommonJS
const { startTunnel } = require("untun");

Start tunnel:

const tunnel = await startTunnel({ port: 3000 });

Options

url

• Default: {protocol}://{hostname}:{port}

The local server URL to tunnel.

port

• Default: 3000

The local server PORT (only effective if url is not provided).

hostname

• Default: localhost

The local server hostname (only effective if url is not provided).

protocol

• Default: http

The local server protocol (only effective if url is not provided).

verifyTLS

• Default: false

Verify local server TLS certificate.

acceptCloudflareNotice

• Default: false
• Environment variable: UNTUN_ACCEPT_CLOUDFLARE_NOTICE

Accept cloudflare TOS by default.

Development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

License

Made with 💛

Published under MIT License.

cloudflared integration based on a fork of JacobLinCool/node-cloudflared

Your installation of cloudflared software constitutes a symbol of your signature indicating that you accept the terms of the Cloudflare License, Terms and Privacy Policy.

Changelog

v0.1.3

compare changes

🚀 Enhancements

• Allow to accept cloudflare notice (#13)

🏡 Chore

• Update dependencies (b1494d7)
• release: V0.1.2 (73ab2ca)
• Update cloudflared to 2023.10.0 (90008ca)
• Update dev dependencies (fdbcf50)
• Document acceptCloudflareNotice option (#13)

❤️ Contributors

• Pooya Parsa (@pi0)
• Anbraten [e-mail]